<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs for page authenticationEmail.php</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="file-name"><img src="../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/authenticationEmail.php</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
									<a href="#sec-includes">Includes</a>
			|											<a href="#sec-functions">Functions</a>
			</div>
	<div class="info-box-body">	
		<!-- ========== Info from phpDoc block ========= -->
		
			</div>
</div>
		

	<a name="sec-includes"></a>	
	<div class="info-box">
		<div class="info-box-title">Includes</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Includes</span>
			|													<a href="#sec-functions">Functions</a>
					</div>
		<div class="info-box-body">	
			<a name="_lib/controller_php"><!-- --></a>
<div class="evenrow">
	
	<div>
		<img src="../media/images/Page.png" alt=" " />
		<span class="include-title">
			<span class="include-type">require_once</span>
			(<span class="include-name"><a href="../default/_lib---controller.php.html">'lib/controller.php'</a></span>)
			(line <span class="line-number">2</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	
</div>
		</div>
	</div>
	
	
	
	<a name="sec-functions"></a>	
	<div class="info-box">
		<div class="info-box-title">Functions</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-includes">Includes</a>
				|												<span class="disabled">Functions</span>
		</div>
		<div class="info-box-body">	
			<a name="functionactivationEmailMessage" id="functionactivationEmailMessage"><!-- --></a>
<div class="oddrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">activationEmailMessage</span> (line <span class="line-number">107</span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The email message to activate a persons account</p>
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			activationEmailMessage
		</span>
					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$userId</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$userName</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$authCode</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$userId</span>			</li>
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$userName</span>			</li>
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$authCode</span>			</li>
				</ul>
		
	
</div>
<a name="functionauthEmailForm" id="functionauthEmailForm"><!-- --></a>
<div class="evenrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">authEmailForm</span> (line <span class="line-number">8</span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Show the form to send an authentication email</p>
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			authEmailForm
		</span>
				()
			</div>

		
	
</div>
<a name="functionauthenticationEmailSent" id="functionauthenticationEmailSent"><!-- --></a>
<div class="oddrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">authenticationEmailSent</span> (line <span class="line-number">179</span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Say that the authentication email has been sent</p>
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			authenticationEmailSent
		</span>
					(<span class="var-type">int</span>&nbsp;<span class="var-name">$userId</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$userId</span>			</li>
				</ul>
		
	
</div>
<a name="functioncreateAuthorisationCode" id="functioncreateAuthorisationCode"><!-- --></a>
<div class="evenrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">createAuthorisationCode</span> (line <span class="line-number">92</span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Create an authorisation code for a user</p>
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			createAuthorisationCode
		</span>
					(<span class="var-type">int</span>&nbsp;<span class="var-name">$userId</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$userId</span>			</li>
				</ul>
		
	
</div>
<a name="functiongetUserEmail" id="functiongetUserEmail"><!-- --></a>
<div class="oddrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">getUserEmail</span> (line <span class="line-number">28</span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get the users email address</p>
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getUserEmail
		</span>
					(<span class="var-type">int</span>&nbsp;<span class="var-name">$userId</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$userId</span>			</li>
				</ul>
		
	
</div>
<a name="functioninsertAuthCode" id="functioninsertAuthCode"><!-- --></a>
<div class="evenrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">insertAuthCode</span> (line <span class="line-number">53</span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Save an authentication code to the database</p>
	<div class="method-signature">
		<span class="method-result">int</span>
		<span class="method-name">
			insertAuthCode
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$authCode</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$authCode</span>			</li>
				</ul>
		
	
</div>
<a name="functionsendAuthEmail" id="functionsendAuthEmail"><!-- --></a>
<div class="oddrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sendAuthEmail</span> (line <span class="line-number">167</span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Send an email about the successfully created Remembrance page</p>
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			sendAuthEmail
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$toEmail</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$subject</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$toEmail</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$subject</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$message</span>			</li>
				</ul>
		
	
</div>
<a name="functionsendEmail" id="functionsendEmail"><!-- --></a>
<div class="evenrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sendEmail</span> (line <span class="line-number">152</span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Send an email</p>
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			sendEmail
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$fromName</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$fromEmail</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$toEmail</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$subject</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$fromName</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$fromEmail</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$toEmail</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$subject</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$message</span>			</li>
				</ul>
		
	
</div>
<a name="functionsetUserAuthId" id="functionsetUserAuthId"><!-- --></a>
<div class="oddrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">setUserAuthId</span> (line <span class="line-number">73</span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Update the user reference to an authentication id number</p>
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			setUserAuthId
		</span>
					(<span class="var-type">int</span>&nbsp;<span class="var-name">$userId</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$authId</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$userId</span>			</li>
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$authId</span>			</li>
				</ul>
		
	
</div>
		</div>
	</div>
	
	<p class="notes" id="credit">
		Documentation generated on Thu, 18 Jun 2009 14:07:58 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
	</p>
	</div></body>
</html>